[docs] docs: unbloat repo-memory reference - #48468
Merged
Merged
Conversation
github-actions
Bot
added
automation
doc-unbloat
documentation
pelikhan
approved these changes
Jul 28, 2026
pelikhan
marked this pull request as ready for review
July 28, 2026 01:36
Contributor
Author
|
✅ Test Quality Sentinel completed test quality analysis. No test files were added or modified in this PR. PR #48468 is documentation-only ([docs] docs: unbloat repo-memory reference), modifying docs/src/content/docs/reference/repo-memory.md. Test Quality Sentinel skipped. |
Contributor
There was a problem hiding this comment.
Pull request overview
Condenses the repo-memory reference while retaining its configuration, behavior, troubleshooting, and security guidance.
Changes:
- Streamlines configuration and behavior explanations.
- Condenses troubleshooting, security, and related-documentation sections.
- Preserves examples, links, and the comparison table.
Show a summary per file
| File | Description |
|---|---|
docs/src/content/docs/reference/repo-memory.md |
Shortens the repo-memory reference documentation. |
Review details
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 1/1 changed files
- Comments generated: 2
- Review effort level: Medium
| **JSON Formatting**: Use `format-json: true` to automatically pretty-print all `.json` files (2-space indent, trailing newline) before they are committed. This makes JSON memory files human-readable in the repository and easier to review and edit manually. Invalid JSON files are skipped with a warning. This option has no effect on `.jsonl` or other file types. | ||
|
|
||
| **Patch Size Limit**: Use `max-patch-size` to limit the total size of changes in a single push (default: 10KB, max: 1MB). The total size of the git diff (all staged changes combined) must not exceed this value. If it does, the push is rejected with an error. Use this to prevent large unintentional memory updates. | ||
| `branch-prefix` changes the default `memory` prefix and must be 4-32 alphanumeric, hyphen, or underscore characters; it cannot be `copilot`. `allowed-extensions` limits which file types can be stored, `format-json: true` pretty-prints `.json` files before commit, and `max-patch-size` caps the total diff size for one push (default 10KB, max 1MB) to prevent oversized updates. |
|
|
||
| :::note[Signed-commit fallback limitation] | ||
| The GraphQL mutation does not support symlinks, executable files (`chmod +x`), or submodule entries. If your memory artifact contains any of these, the helper falls back to a plain `git push`, which will be rejected by signed-commit rulesets. Keep memory artifacts as regular plain-text files (`.json`, `.jsonl`, `.txt`, `.md`, `.csv` — the default `allowed-extensions`). | ||
| The GraphQL mutation does not support symlinks, executable files (`chmod +x`), or submodule entries. If your memory artifact contains any of these, the helper falls back to a plain `git push`, which signed-commit rulesets usually reject. Keep memory artifacts as regular plain-text files such as `.json`, `.jsonl`, `.txt`, `.md`, and `.csv`. |
Closed
Contributor
Author
|
🎉 This pull request is included in a new release. Release: |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Condenses the repo-memory reference page for readability and maintainability. No functional or behavioral changes; documentation only.
Changes
Detail
Impact